人人都知道，寫程式要寫註解。但是註解要寫得好，寫得不多也不少，寫得有意義，寫得讓人印象深刻，讓人會心一笑，就沒有那麼容易。這裡要談的，是最不想看到的程式註解。
海綿寶曾經奉指示維護一套藥品庫存管理系統，除了瓶瓶罐罐幾顆幾粒的最小單位之外，大致上跟一般進銷存系統差不多。
差不多是差不多，但是每個月底過帳盤點的時侯，數量總是會出問題，數量不是短缺就是多出來，由於差異並不太大，而使用者也不可能照實盤點，所以就睜隻眼閉隻眼，讓海綿寶將資料庫中的資料手動調整一下就算過了。
有一次轉檔過帳時程式出現錯誤而異常終止，海綿寶按著前人交接下來的文件，逐段逐行地Trace程式，最後來到了一個IF判斷式，而依據條件判斷，應該走到False這部份，此時，看到了一段寧願沒看到的程式註解：
//注意！如果程式跑到這裡，就真的掛了
看著前人的黑色幽默，只能苦笑了。
以上為真人真事，唯一與事實有「小小」差別的是，那個「前人」就是海綿寶，看到註解的是海綿寶的徒弟….Orz。
**結論：**寫程式要寫有意義的註解，過與不及都不好。
iThome鐵人賽
看影片追技術